Resend Mobile OTP
This document outlines the details of the Resend Mobile OTP API.
API Description
Objective
| Input | Output |
|---|---|
| The user's mobile number for the verification retry attempt | The API resends an OTP to the user's email and returns a relevant JSON response |
API URL
https://ind-engine.thomas.hyperverge.co/v1/resendOtp
API Endpoint
resendOtp
API Request Details
Overview
The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format, and you should upload all images and files as form-data through a POST request.
Authentication
You need a unique pair of application ID (appId) and application key (appKey) from HyperVerge to verify your identity for accessing the API.
Method - POST
Headers
| Parameter | Mandatory or Optional | Description | Allowed Values |
|---|---|---|---|
| content-type | Mandatory | The media type for the request payload. | application/json |
| appId | Mandatory | The application identifier shared by HyperVerge. You can find the details in the dashboard's credentials tab. | This should be a unique value. |
| appKey | Mandatory | The application key shared by HyperVerge. You can find the details in the dashboard's credentials tab. | This should be a unique value. |
| transactionId | Mandatory | A unique identifier for tracking a user journey. | This should be both unique and easily associated with the user's journey in your application(s). |
Inputs
| Parameter | Description | Mandatory or Optional | Allowed Values | Default Value |
|---|---|---|---|---|
mobileNumber | The ten-digit mobile number of the user based in India | Mandatory | A valid ten-digit phone number | Not Applicable |
retryType | Determines the type of OTP for the verification process | Optional | 'voice' or 'text' | 'voice' |
Request
The following is a standard cURL request for the API.
curl --location --request POST 'https://ind-engine.thomas.hyperverge.co/v1/resendOtp' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
"mobileNumber": "<Enter_the_Mobile_Number_of_the_User_for_Verification>",
"retryType": "<voice_or_text>"
}'
Success Response
{
"status": "success",
"statusCode": 200,
"metaData": {
"requestId": "<Request_Identifier>"
}
}